API Endpoints

Overview

FF-API-External provides a wide range of API endpoints organized by category. This document details the available endpoints, request parameters, and response formats.

Table of Contents

• AI Endpoints
  • OpenAI ChatGPT
  • Anthropic Claude
• Vehicle Information
  • Car API
  • VIN Decoder
  • Vehicle Database
  • Bikez Motorcycle Data
  • Zyla Automotive Car Specs
  • API Ninja Car API
• Device Information
  • GSM Arena
  • IMEI to Model
  • IMEI Info
• Search and SERP
  • Google Place Search
  • Google Image Search
  • Google Event Search
  • Item Search
• Geolocation
  • Google Maps Geocoding
  • GhanaPostGPS
• Miscellaneous
  • Matterport
  • Paystack
  • Hubtel SMS
  • Fingerprint Pro
  • Brevo

AI Endpoints

OpenAI ChatGPT

Generate Response

POST /api/v1/openai/chatgpt/prompt

Generate a text response using OpenAI's ChatGPT model.

Parameters:

• prompt (required): The input text to generate a response for

Example Response:

{
  "status": 200,
  "data": "Response from ChatGPT..."
}

Get Product Specifications

GET /api/v1/openai/chatgpt/prompt/product/spec

Get specifications for a product based on a prompt.

Parameters:

• prompt (required): Description of the product

Match Products

GET /api/v1/openai/chatgpt/prompt/product/match
GET /api/v2/openai/chatgpt/prompt/product/match

Match user input to known products.

Parameters:

• prompt (required): User input to match
• etypes (optional): Entity types to consider

Extract Keywords & Metadata

POST /api/v1/openai/chatgpt/prompt/listing/metadata

Extract keywords and metadata from a product listing.

Parameters:

• JSON payload with listing (required): The product listing data
• Optional parameters: full, model, temperature, max_tokens

Anthropic Claude

Generate Response

POST /api/v1/claude/prompt

Generate a text response using Anthropic's Claude model.

Parameters:

• prompt (required): The input text
• max_tokens (optional): Maximum length of response
• temperature (optional): Randomness of response
• system_prompt (optional): System instructions

Match Products

POST /api/v1/claude/product/match

Match user input to known products using Claude.

Parameters:

• prompt (required): User input to match
• etypes (optional): Entity types to consider
• full (optional): Whether to return full response
• max_tokens (optional): Maximum length of response
• temperature (optional): Randomness of response

Get Product Specifications

POST /api/v1/claude/product/spec

Get specifications for a product using Claude.

Parameters:

• Similar to product/match endpoint

Get Vehicle Specifications

POST /api/v1/claude/vehicle/spec

Get specifications for a vehicle using Claude.

Parameters:

• year (required): Vehicle year
• make (required): Vehicle make
• model (required): Vehicle model
• full (optional): Whether to return full response
• max_tokens (optional): Maximum length of response
• temperature (optional): Randomness of response

Get Available Claude Models

GET /api/v1/claude/models

Get a list of available Claude models.

Vehicle Information

Car API

GET /api/carapi/makes
GET /api/carapi/models
GET /api/carapi/trims
GET /api/carapi/vin/{vin}

Various endpoints for retrieving car information from the Car API.

VIN Decoder

GET /api/vindecoder/decode/{vin}
GET /api/vindecoder/decode_info/{vin}
GET /api/vindecoder/stolen_check/{vin}
GET /api/vindecoder/vehicle_market_value/{vin}
GET /api/vindecoder/oem_lookup/{vin}
GET /api/vindecoder/balance

Endpoints for decoding Vehicle Identification Numbers (VINs) and retrieving vehicle information.

Vehicle Database

GET /api/vehicledatabase/vin_decode/{vin}
GET /api/vehicledatabase/premium_vin_decode/{vin}
GET /api/vehicledatabase/electric_vehicle
GET /api/vehicledatabase/market_value_vin/{vin}
GET /api/vehicledatabase/market_value_ymm
GET /api/vehicledatabase/vehicle_maintenance
GET /api/vehicledatabase/vehicle_recalls
GET /api/vehicledatabase/vehicle_repairs

Comprehensive vehicle database API with various endpoints for vehicle information.

Bikez Motorcycle Data

GET /api/bikez/get_brands
GET /api/bikez/get_models
GET /api/bikez/get_model_variants
POST /api/bikez/save_brands
POST /api/bikez/save_models
POST /api/bikez/save_model_variants

Endpoints for retrieving and managing motorcycle data.

Zyla Automotive Car Specs

GET /api/zyla/carapi/makers
GET /api/zyla/carapi/models/{make_identifiers}
GET /api/zyla/carapi/models/{make_identifier}/{year}
GET /api/zyla/carapi/generations/{model_ids}
GET /api/zyla/carapi/trims/{make}/{model}/{year}
GET /api/zyla/carapi/trims/{generation_id}
GET /api/zyla/carapi/specs/{trim_id}

Endpoints for automotive specifications and details.

API Ninja Car API

GET /api/apininja/carapi/cars
GET /api/apininja/carapi/carmakes
GET /api/apininja/carapi/carmodels
GET /api/apininja/carapi/vinlookup

Car information API using the API Ninja service.

Device Information

GSM Arena

GET /api/v1/gsmarena/brands
GET /api/v1/gsmarena/device-list
POST /api/v1/gsmarena/brands/fetch
POST /api/v1/gsmarena/devices/fetch
POST /api/v1/gsmarena/device/detail/fetch
GET /api/v1/gsmarena/raw/brands
GET /api/v1/gsmarena/raw/device-list
GET /api/v1/gsmarena/raw/brands/{brand_id}/devices
GET /api/v1/gsmarena/raw/device/{device_url}

Endpoints for retrieving mobile device information from GSM Arena.

IMEI to Model

GET /api/imeitomodel/checkvalid/{imei}
GET /api/imeitomodel/getmodel/{imei}

Validate and get device information from IMEI numbers.

IMEI Info

GET /api/imeiinfo/account_details
GET /api/imeiinfo/bulk_search/history
POST /api/imeiinfo/bulk_search
GET /api/imeiinfo/check_imei/{service_id}/{imei}
GET /api/imeiinfo/services

Advanced IMEI information and services.

Search and SERP

Google Place Search

GET /api/v1/place/serp/search
GET /api/v1/place/serp/searchbyid

Search for places using Google SERP API.

Google Image Search

GET /serp/image/search/vehicle/{year}/{make}/{model}
GET /serp/image/search/vehicle/{year}/{make}/{model}/{trim}
GET /serp/image/search/mobile_device/{brand}/{model}
GET /serp/image/search/generic/{prompt}

Search for images of vehicles, mobile devices, or generic items.

Google Event Search

GET /api/v1/event/serp/search

Search for events using Google SERP API.

Item Search

GET /serp/item/google/shopping/search/{prompt}

Search for shopping items using Google Shopping.

Geolocation

Google Maps Geocoding

GET /api/gcloud/geocode/

Get administrative hierarchy information for given coordinates.

GhanaPostGPS

GET /api/v1/ghanapostgps/get-location/{code}
GET /api/v1/ghanapostgps/get-address/{lat}/{long}

Get location from address code or coordinates in Ghana.

Miscellaneous

Matterport

GET /api/matterport/models/all
GET /api/matterport/models/all/{name}
GET /api/matterport/models/internal_id/{id}
GET /api/matterport/model/{model_id}/sweeps
GET /api/matterport/model/{model_id}/snapshots
GET /api/matterport/model/{model_id}/tags

3D space and virtual tour API endpoints.

Paystack

POST /api/paystack/transactions/initialize
GET /api/paystack/transactions/verify/{reference}
GET /api/paystack/transactions/{transaction_id}
POST /api/paystack/transfers/recipient
GET /api/paystack/banks

Payment processing API endpoints.

Hubtel SMS

GET /api/hubtel/send-quick-sms
POST /api/hubtel/send-regular-sms
GET /api/hubtel/message-status/{message_id}

SMS communication API endpoints.

Fingerprint Pro

GET /api/fingerprint/visitor/{visitor_id}
POST /api/fingerprint/visitor
PUT /api/fingerprint/visitor/{visitor_id}
DELETE /api/fingerprint/visitor/{visitor_id}
POST /api/fingerprint/identify
POST /api/fingerprint/visitor/{visitor_id}/event
GET /api/fingerprint/event/{request_id}

Device fingerprinting and visitor tracking API.

Brevo

POST /api/brevo/send-email
POST /api/brevo/send-batch-email
POST /api/brevo/send-template-email
POST /api/brevo/send-whatsapp-message
GET /api/brevo/whatsapp-events

Email and WhatsApp messaging API.